home *** CD-ROM | disk | FTP | other *** search
/ Skunkware 5 / Skunkware 5.iso / man / cat.n / scrollbar.n < prev    next >
Text File  |  1995-07-25  |  14KB  |  264 lines
  1.  
  2.  
  3.  
  4.      ssssccccrrrroooollllllllbbbbaaaarrrr((((nnnn))))                 TTTTkkkk (((( ))))                  ssssccccrrrroooollllllllbbbbaaaarrrr((((nnnn))))
  5.  
  6.  
  7.  
  8.      _________________________________________________________________
  9.  
  10.      NNNNAAAAMMMMEEEE
  11.           scrollbar - Create and manipulate scrollbar widgets
  12.  
  13.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  14.           ssssccccrrrroooollllllllbbbbaaaarrrr _p_a_t_h_N_a_m_e ?_o_p_t_i_o_n_s?
  15.  
  16.      SSSSTTTTAAAANNNNDDDDAAAARRRRDDDD OOOOPPPPTTTTIIIIOOOONNNNSSSS
  17.           aaaaccccttttiiiivvvveeeeFFFFoooorrrreeeeggggrrrroooouuuunnnndddd               ccccuuuurrrrssssoooorrrr          rrrreeeelllliiiieeeeffff         |
  18.           bbbbaaaacccckkkkggggrrrroooouuuunnnndddd      ffffoooorrrreeeeggggrrrroooouuuunnnndddd     rrrreeeeppppeeeeaaaattttDDDDeeeellllaaaayyyy
  19.           bbbboooorrrrddddeeeerrrrWWWWiiiiddddtttthhhh     oooorrrriiiieeeennnntttt         rrrreeeeppppeeeeaaaattttIIIInnnntttteeeerrrrvvvvaaaallll
  20.  
  21.           See the ``options'' manual entry for details on the standard
  22.           options.
  23.  
  24.      WWWWIIIIDDDDGGGGEEEETTTT----SSSSPPPPEEEECCCCIIIIFFFFIIIICCCC OOOOPPPPTTTTIIIIOOOONNNNSSSS
  25.           Name:           ccccoooommmmmmmmaaaannnndddd
  26.           Class:          CCCCoooommmmmmmmaaaannnndddd
  27.           Command-Line Switch:----ccccoooommmmmmmmaaaannnndddd
  28.  
  29.                Specifies the prefix of a  Tcl  command  to  invoke  to
  30.                change  the  view  in  the  widget  associated with the
  31.                scrollbar.  When a  user  requests  a  view  change  by
  32.                manipulating  the  scrollbar, a Tcl command is invoked.
  33.                The actual command consists of this option followed  by
  34.                a space and a number.  The number indicates the logical
  35.                unit that should appear at the top  of  the  associated
  36.                window.
  37.  
  38.           Name:           wwwwiiiiddddtttthhhh
  39.           Class:          WWWWiiiiddddtttthhhh
  40.           Command-Line Switch:----wwwwiiiiddddtttthhhh
  41.  
  42.                Specifies the desired narrow dimension of the scrollbar
  43.                window, not including 3-D border, if any.  For vertical
  44.                scrollbars this will be the width  and  for  horizontal
  45.                scrollbars this will be the height.  The value may have  |
  46.                any of the forms acceptable to TTTTkkkk____GGGGeeeettttPPPPiiiixxxxeeeellllssss.
  47.      _________________________________________________________________
  48.  
  49.  
  50.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  51.           The ssssccccrrrroooollllllllbbbbaaaarrrr command creates a new  window  (given  by  the
  52.           _p_a_t_h_N_a_m_e  argument)  and  makes  it into a scrollbar widget.
  53.           Additional options, described above, may be specified on the
  54.           command  line or in the option database to configure aspects
  55.           of the  scrollbar  such  as  its  colors,  orientation,  and
  56.           relief.    The   ssssccccrrrroooollllllllbbbbaaaarrrr   command  returns  its  _p_a_t_h_N_a_m_e
  57.           argument.  At the time this command is invoked,  there  must
  58.           not  exist  a  window  named _p_a_t_h_N_a_m_e, but _p_a_t_h_N_a_m_e's parent
  59.           must exist.
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 7/23/95)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      ssssccccrrrroooollllllllbbbbaaaarrrr((((nnnn))))                 TTTTkkkk (((( ))))                  ssssccccrrrroooollllllllbbbbaaaarrrr((((nnnn))))
  71.  
  72.  
  73.  
  74.           A scrollbar is a widget that displays  two  arrows,  one  at
  75.           each  end  of  the  scrollbar,  and  a  _s_l_i_d_e_r in the middle
  76.           portion of the scrollbar.  A scrollbar is  used  to  provide
  77.           information  about  what  is visible in an _a_s_s_o_c_i_a_t_e_d _w_i_n_d_o_w
  78.           that displays an object of some sort (such as a  file  being
  79.           edited  or  a drawing).  The position and size of the slider
  80.           indicate which portion of  the  object  is  visible  in  the
  81.           associated window.  For example, if the slider in a vertical
  82.           scrollbar covers the top third of the area between  the  two
  83.           arrows, it means that the associated window displays the top
  84.           third of its object.
  85.  
  86.           Scrollbars can be used to adjust the view in the  associated
  87.           window  by  clicking  or  dragging  with the mouse.  See the
  88.           BINDINGS section below for details.
  89.  
  90.  
  91.      WWWWIIIIDDDDGGGGEEEETTTT CCCCOOOOMMMMMMMMAAAANNNNDDDD
  92.           The ssssccccrrrroooollllllllbbbbaaaarrrr command creates a new Tcl command  whose  name
  93.           is  _p_a_t_h_N_a_m_e.   This  command  may be used to invoke various
  94.           operations on the widget.   It  has  the  following  general
  95.           form:
  96.  
  97.                _p_a_t_h_N_a_m_e _o_p_t_i_o_n ?_a_r_g _a_r_g ...?
  98.           _O_p_t_i_o_n and the _a_r_gs determine  the  exact  behavior  of  the
  99.           command.   The following commands are possible for scrollbar
  100.           widgets:
  101.  
  102.           _p_a_t_h_N_a_m_e ccccoooonnnnffffiiiigggguuuurrrreeee ?_o_p_t_i_o_n? ?_v_a_l_u_e _o_p_t_i_o_n _v_a_l_u_e ...?
  103.                Query  or  modify  the  configuration  options  of  the
  104.                widget.   If  no  _o_p_t_i_o_n  is  specified, returns a list
  105.                describing all of the available  options  for  _p_a_t_h_N_a_m_e
  106.                (see  TTTTkkkk____CCCCoooonnnnffffiiiigggguuuurrrreeeeIIIInnnnffffoooo for information on the format of
  107.                this list).  If _o_p_t_i_o_n is specified with no _v_a_l_u_e, then
  108.                the  command  returns  a  list describing the one named
  109.                option  (this   list   will   be   identical   to   the
  110.                corresponding  sublist  of  the  value  returned  if no
  111.                _o_p_t_i_o_n is specified).   If  one  or  more  _o_p_t_i_o_n-_v_a_l_u_e
  112.                pairs  are  specified,  then  the  command modifies the
  113.                given widget option(s) to have the given value(s);   in
  114.                this  case the command returns an empty string.  _O_p_t_i_o_n
  115.                may have any of the values accepted  by  the  ssssccccrrrroooollllllllbbbbaaaarrrr
  116.                command.
  117.  
  118.           _p_a_t_h_N_a_m_e ggggeeeetttt
  119.                Returns a Tcl  list  containing  four  decimal  values,
  120.                which   are   the   current   _t_o_t_a_l_U_n_i_t_s,  _w_i_d_n_o_w_U_n_i_t_s,
  121.                _f_i_r_s_t_U_n_i_t,  and  _l_a_s_t_U_n_i_t  values  for  the  scrollbar.
  122.                These  are  the  values from the most recent sssseeeetttt widget
  123.                command on the scrollbar.
  124.  
  126.  
  127.  
  128.      Page 2                                          (printed 7/23/95)
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.      ssssccccrrrroooollllllllbbbbaaaarrrr((((nnnn))))                 TTTTkkkk (((( ))))                  ssssccccrrrroooollllllllbbbbaaaarrrr((((nnnn))))
  136.  
  137.  
  138.  
  139.           _p_a_t_h_N_a_m_e sssseeeetttt _t_o_t_a_l_U_n_i_t_s _w_i_n_d_o_w_U_n_i_t_s _f_i_r_s_t_U_n_i_t _l_a_s_t_U_n_i_t
  140.                This  command  is  invoked  to   give   the   scrollbar
  141.                information   about  the  widget  associated  with  the
  142.                scrollbar.  _T_o_t_a_l_U_n_i_t_s is an integer value  giving  the
  143.                total  size  of  the  object  being  displayed  in  the
  144.                associated widget.  The meaning of one unit depends  on
  145.                the  associated  widget;  for example, in a text editor
  146.                widget  units  might  correspond  to  lines  of   text.
  147.                _W_i_n_d_o_w_U_n_i_t_s  indicates  the  total number of units that
  148.                can  fit  in  the  associated  window  at   one   time.
  149.                _F_i_r_s_t_U_n_i_t  and  _l_a_s_t_U_n_i_t  give the indices of the first
  150.                and last units  currently  visible  in  the  associated
  151.                window  (zero  corresponds  to  the  first  unit of the
  152.                object).   This  command  should  be  invoked  by   the
  153.                associated widget whenever its object or window changes
  154.                size and whenever it changes the view in its window.
  155.  
  156.  
  157.      BBBBIIIINNNNDDDDIIIINNNNGGGGSSSS
  158.           The  description   below   assumes   a   vertically-oriented
  159.           scrollbar.   For  a  horizontally-oriented scrollbar replace
  160.           the words ``up'', ``down'',  ``top'',  and  ``bottom''  with
  161.           ``left'', ``right'', ``left'', and ``right'', respectively
  162.  
  163.           A scrollbar widget is  divided  into  five  distinct  areas.
  164.           From  top  to  bottom, they are:  the top arrow, the top gap
  165.           (the empty space between the  arrow  and  the  slider),  the
  166.           slider,  the  bottom  gap,  and  the bottom arrow.  Pressing
  167.           mouse button 1 in each area has a different effect:
  168.  
  169.           ttttoooopppp aaaarrrrrrrroooowwww           Causes the view in the associated window
  170.                               to shift up by one unit (i.e. the object
  171.                               appears to move down  one  unit  in  its
  172.                               window).  If the button is held down the
  173.                               action will auto-repeat.
  174.  
  175.           ttttoooopppp ggggaaaapppp             Causes the view in the associated window
  176.                               to  shift up by one less than the number
  177.                               of units in the window (i.e. the portion
  178.                               of the object that used to appear at the
  179.                               very top of the window will  now  appear
  180.                               at  the  very bottom).  If the button is
  181.                               held down the action will auto-repeat.
  182.  
  183.           sssslllliiiiddddeeeerrrr              Pressing button 1 in this  area  has  no
  184.                               immediate  effect  except  to  cause the
  185.                               slider  to  appear  sunken  rather  than
  186.                               raised.   However, if the mouse is moved
  187.                               with the button  down  then  the  slider
  188.                               will  be  dragged, adjusting the view as
  189.                               the mouse is moved.
  190.  
  191.  
  192.  
  193.  
  194.      Page 3                                          (printed 7/23/95)
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.      ssssccccrrrroooollllllllbbbbaaaarrrr((((nnnn))))                 TTTTkkkk (((( ))))                  ssssccccrrrroooollllllllbbbbaaaarrrr((((nnnn))))
  202.  
  203.  
  204.  
  205.           bbbboooottttttttoooommmm ggggaaaapppp          Causes the view in the associated window
  206.                               to  shift  down  by  one  less  than the
  207.                               number of units in the window (i.e.  the
  208.                               portion  of  the  object  that  used  to
  209.                               appear at the very bottom of the  window
  210.                               will  now  appear  at the very top).  If
  211.                               the button is held down the action  will
  212.                               auto-repeat.
  213.  
  214.           bbbboooottttttttoooommmm aaaarrrrrrrroooowwww        Causes the view in the associated window
  215.                               to  shift  down  by  one  unit (i.e. the
  216.                               object appears to move up  one  unit  in
  217.                               its window).  If the button is held down
  218.                               the action will auto-repeat.
  219.  
  220.           Note:  none of the actions described above has an  immediate
  221.           impact  on  the position of the slider in the scrollbar.  It
  222.           simply invokes the command specified in the  ccccoooommmmmmmmaaaannnndddd  option
  223.           to  notify  the  associated  widget that a change in view is
  224.           desired.   If  the  view  is  actually  changed   then   the
  225.           associated  widget  must  invoke  the scrollbar's sssseeeetttt widget
  226.           command to change what is displayed in the scrollbar.
  227.  
  228.  
  229.      KKKKEEEEYYYYWWWWOOOORRRRDDDDSSSS
  230.           scrollbar, widget
  231.  
  232.  
  233.  
  234.  
  235.  
  236.  
  237.  
  238.  
  239.  
  240.  
  241.  
  242.  
  243.  
  244.  
  245.  
  246.  
  247.  
  248.  
  249.  
  250.  
  251.  
  252.  
  253.  
  254.  
  255.  
  256.  
  257.  
  258.  
  259.  
  260.      Page 4                                          (printed 7/23/95)
  261.  
  262.  
  263.  
  264.